Skip to content

Review Datasets#11753

Open
pdurbin wants to merge 60 commits intodevelopfrom
11747-review-dataset-type
Open

Review Datasets#11753
pdurbin wants to merge 60 commits intodevelopfrom
11747-review-dataset-type

Conversation

@pdurbin
Copy link
Member

@pdurbin pdurbin commented Aug 19, 2025

What this PR does / why we need it:

Makes creation of review datasets possible.

Which issue(s) this PR closes:

Special notes for your reviewer:

Suggestions on how to test this:

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Dataset Type facet values are now lowercase

The facets under "Dataset Type" are changing from human readable and translatable ("Dataset" from getDisplayName) to machine-readable ("dataset" from getName). This is to fix #11758 and IQSS/dataverse-frontend#809

Before

Screenshot 2026-02-06 at 11 35 43 AM

After

Screenshot 2026-02-06 at 11 36 00 AM

Note that I'm aware that even after this fix, when you click any of the machine readable names, such as "software", the friendly name will appear above the search results like this:

Screenshot 2026-02-06 at 11 36 30 AM

I left a note in the xhtml about this. I don't think this is worth fixing on the JSF side. In the SPA, the values will consistently be the machine readable versions, such as "software" (lower case).

Review Metadata/Item Reviewed

Also, a "Review Metadata" block has been added. The primary field is "Item Reviewed" (#12015) and it looks like this (see IQSS/dataverse-frontend#876 (comment) for how it looks in the SPA):

Screenshot 2026-03-04 at 11 21 11 AM

Dataset Type dropdown (SPA only)

The "Dataset Type" dropdown does not appear in JSF but here's how it looks in the SPA (see IQSS/dataverse-frontend#876 (comment) for more context):

Screenshot 2026-03-04 at 10 42 18 AM

If allowedDatasetTypes does not include "dataset"

If you have configured a collection to only allow "review" (or only "software", or only "review" and "software" or whatever but not "dataset") for allowedDatasetTypes, you will get an error in JSF if you try to create a "dataset" dataset type (which is the only dataset type JSF knows how to create), like this:

Screenshot 2026-03-06 at 2 02 32 PM

Is there a release notes update needed for this change?:

Included

@coveralls
Copy link

coveralls commented Aug 19, 2025

Coverage Status

coverage: 24.619% (-0.03%) from 24.644%
when pulling 92c95e6 on 11747-review-dataset-type
into d988622 on develop.

@github-actions

This comment has been minimized.

@pdurbin pdurbin force-pushed the 11747-review-dataset-type branch from dc893bc to 7c629a2 Compare August 26, 2025 14:26
@github-actions

This comment has been minimized.

@cmbz cmbz added the Size: 10 A percentage of a sprint. 7 hours. label Aug 27, 2025
@pdurbin pdurbin moved this from In Progress 💻 to Ready for Review ⏩ in IQSS Dataverse Project Aug 27, 2025
@pdurbin pdurbin removed their assignment Aug 27, 2025
@pdurbin pdurbin marked this pull request as ready for review August 27, 2025 19:08
@jggautier jggautier changed the title add "review" dataset type add "review" dataset type and related metadata blocks Aug 27, 2025
@jggautier
Copy link
Contributor

Next Tuesday I'll add to this PR . properties files for the two metadata blocks

@cmbz cmbz added the FY26 Sprint 5 FY26 Sprint 5 (2025-08-27 - 2025-09-10) label Aug 28, 2025
@jggautier
Copy link
Contributor

I put the two properties files for the metadata blocks into this branch's src/main/java/propertyFiles folder

@github-actions

This comment has been minimized.

@cmbz cmbz added the FY26 Sprint 6 FY26 Sprint 6 (2025-09-10 - 2025-09-24) label Sep 14, 2025
@pdurbin pdurbin force-pushed the 11747-review-dataset-type branch from ef2f080 to db4c453 Compare September 17, 2025 18:08
@github-actions

This comment has been minimized.

@pdurbin pdurbin moved this from Ready for Review ⏩ to In Progress 💻 in IQSS Dataverse Project Sep 17, 2025
@cmbz cmbz added the FY26 Sprint 7 FY26 Sprint 7 (2025-09-24 - 2025-10-08) label Sep 24, 2025
@pdurbin pdurbin force-pushed the 11747-review-dataset-type branch from db4c453 to 44e2c17 Compare September 26, 2025 13:53
@github-actions

This comment has been minimized.

@pdurbin pdurbin force-pushed the 11747-review-dataset-type branch from 44e2c17 to e41d0e3 Compare September 30, 2025 20:07
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

pdurbin added 2 commits March 6, 2026 12:46
As of be670d4 we are putting "required" in review.tsv so
in this commit we are updating the test code to no longer
set "required" at the collection level.
@github-actions

This comment has been minimized.

if (existingDatasetType != null) {
// A dataset type can be specified via API, for example.
theDataset.setDatasetType(existingDatasetType);
List<DatasetType> allowedByCollection = theDataset.getOwner().getAllowedDatasetTypes();
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@scolapasta found a bug in this part of the code. As of 050439d, in JSF, one is still able to create a dataset in a collection that only allows review. I have a fix ready, which I'll push.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 2b03a64. Here's how the error looks in JSF:

Image

@github-actions

This comment has been minimized.

2 similar comments
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

allowedDatasetTypes is for collections.
linkedMetadataBlocks is for dataset types.
@github-actions

This comment has been minimized.

@pdurbin
Copy link
Member Author

pdurbin commented Mar 6, 2026

Based on testing, I made the following changes:

2b03a64 better handling of collections disallowing "dataset" datasetType #12115 #11747
38ec9a7 move "create collection" step down, just before "allow type" #11747
bebb87b add sample file dataset-create-review.json #11747

I also opened the following issue which can be observed in this pull request as well as the "develop" branch:

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

1 similar comment
@github-actions
Copy link

github-actions bot commented Mar 9, 2026

📦 Pushed preview images as

ghcr.io/gdcc/dataverse:11747-review-dataset-type
ghcr.io/gdcc/configbaker:11747-review-dataset-type

🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FY26 Sprint 5 FY26 Sprint 5 (2025-08-27 - 2025-09-10) FY26 Sprint 6 FY26 Sprint 6 (2025-09-10 - 2025-09-24) FY26 Sprint 7 FY26 Sprint 7 (2025-09-24 - 2025-10-08) FY26 Sprint 8 FY26 Sprint 8 (2025-10-08 - 2025-10-22) FY26 Sprint 9 FY26 Sprint 9 (2025-10-22 - 2025-11-05) FY26 Sprint 10 FY26 Sprint 10 (2025-11-05 - 2025-11-19) FY26 Sprint 11 FY26 Sprint 11 (2025-11-20 - 2025-12-03) FY26 Sprint 12 FY26 Sprint 12 (2025-12-03 - 2025-12-17) FY26 Sprint 13 FY26 Sprint 13 (2025-12-17 - 2025-12-31) FY26 Sprint 14 FY26 Sprint 14 (2025-12-31 - 2026-01-14) FY26 Sprint 15 FY26 Sprint 15 (2026-01-14 - 2026-01-28) FY26 Sprint 16 FY26 Sprint 16 (2026-01-28 - 2026-02-11) FY26 Sprint 17 FY26 Sprint 17 (2026-02-11 - 2026-02-25) FY26 Sprint 18 FY26 Sprint 18 (2026-02-25 - 2026-03-11) Project: Trusted Data Size: 30 A percentage of a sprint. 21 hours. (formerly size:33)

Projects

Status: QA ✅

8 participants